Clarify docstring and mention subclassing of run method #13
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jgarte
force-pushed
the
docstring_updates
branch
from
bbb49f8 to
44019ab
Compare
jgarte
force-pushed
the
docstring_updates
branch
from
da754c0 to
dcd6c28
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi,
I updated the docstring for the
runmethod.Is my clarification correct?
That is,
Driver's should be subclassed to create a more specific driver.I also reworded the Driver class's
infomethod for clarity.Lastly, I rephrased some of the technical prose documentation for clarity.